/*
 * Copyright:  2018 smarabbit studio.
 *
 *  Licensed under the Confluent Community License; you may not use this file
 *  except in compliance with the License.  You may obtain a copy of the License at
 *
 *  http://www.confluent.io/confluent-community-license
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 *  WARRANTIES OF ANY KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations under the License.
 *
 *  @作   者： 黄开晖 (117227773@qq.com)
 *  @日   期:  2020年8月22日
 */
package com.massyframework.beanskin;

import java.util.function.Consumer;

import com.massyframework.beanskin.assembly.Assembly;
import com.massyframework.beanskin.framework.Framework;
import com.massyframework.beanskin.service.ExportServiceDescriptorBuilder;
import com.massyframework.beanskin.service.ServiceRegistration;
import com.massyframework.beanskin.service.awaitstrategy.AwaitStrategyBuilder;

/**
 * 在模块安装时，提供给安装程序使用环境。
 * @author huangkh
 *
 */
public interface Environment<T extends Module<?>> {
	
	/**
	 * 添加等待策略
	 * 
	 * <p>
	 * 如果模块需要等候外部的服务就绪才能执行的程序逻辑，可以通过等待策略，直到所依赖的外部服务就绪后，再执行动作。
	 * 
	 * @param action {@link Consumer}
	 */
	void addAwaitStrategy(Consumer<AwaitStrategyBuilder> action);
		
	/**
	 * 内核装配件
	 * <br>
	 * 内核装配件是Framework启动时，首个创建的，编号为0的模块。
	 * 
	 * @return {@link Assembly}
	 */
	Assembly getKernelAssembly();
	
	/**
	 * 正在安装的模块
	 * 
	 * @return {@link T}
	 */
	T getModule();
	
	/**
	 * 运行框架
	 * @return {@link Framework}
	 */
	Framework getFramework();
	
	/**
	 * 是否运行在debug模式下
	 * @return {@link boolean}, 返回{@code true}表示是，否则返回{@code false}
	 */
	default boolean runAtDebug() {
		String text = this.getKernelAssembly().getConfig().getParameter(Framework.DEBUG_MODEL, "false");
		return Boolean.parseBoolean(text);
	}
	
	/**
	 * 是否运行在j2ee下
	 * @return {@link boolean}, 返回{@code true}表示是，否则返回{@code false}
	 */
	default boolean runAtJ2EE() {
		String text = this.getKernelAssembly().getConfig().getParameter(Framework.RUN_ENVIRONMENT, Framework.RUN_ENVIRONMENT_J2SE);
		return Framework.RUN_ENVIRONMENT_J2EE.equals(text);
	}
	
	
	
	/**
	 * 注册服务
	 * @param service {@link Object},服务实例
	 * @param consumer {@link Consumer},输出服务描述构建器
	 * @return {@link ServiceRegistration},服务注册凭据
	 */
	ServiceRegistration<?> registService(Object service, Consumer<ExportServiceDescriptorBuilder> consumer);
}
